From d19277058e08b5ed5850b00e19e98812c97655af Mon Sep 17 00:00:00 2001 From: Konrad Rzeszutek Wilk Date: Mon, 28 Jan 2013 12:24:02 -0500 Subject: [PATCH] docs: Document the ELF_FEATURES entry Mark-up for inclusion of generated docs. Acked-by: Ian Campbell Signed-off-by: Konrad Rzeszutek Wilk --- xen/include/public/features.h | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/xen/include/public/features.h b/xen/include/public/features.h index 5b70418eeb..a149aa6508 100644 --- a/xen/include/public/features.h +++ b/xen/include/public/features.h @@ -27,6 +27,20 @@ #ifndef __XEN_PUBLIC_FEATURES_H__ #define __XEN_PUBLIC_FEATURES_H__ +/* + * `incontents 200 elfnotes_features XEN_ELFNOTE_FEATURES + * + * The list of all the features the guest supports. They are set by + * parsing the XEN_ELFNOTE_FEATURES and XEN_ELFNOTE_SUPPORTED_FEATURES + * string. The format is the feature names (as given here without the + * "XENFEAT_" prefix) separated by '|' characters. + * If a feature is required for the kernel to function then the feature name + * must be preceded by a '!' character. + * + * Note that if XEN_ELFNOTE_SUPPORTED_FEATURES is used, then in the + * XENFEAT_dom0 MUST be set if the guest is to be booted as dom0, + */ + /* * If set, the guest does not need to write-protect its pagetables, and can * update them via direct writes. -- 2.30.2